/* ========================================================================
 * Copyright 2007 The Apache Software Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless reqired by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ========================================================================
 


 * Created on 1 oct. 2007
 * @author pollux
*/

package org.poxd.frisar.ui;

import java.awt.Component;
import org.poxd.frisar.Frisar;


public abstract class FriseRenderer{
    protected Frisar frise;
    protected String name;

    /**
     * Unique constructore. It's mandatory to pass a frise reference for the
     * rendering process.
     * 
     * @param frise
     */
    public FriseRenderer(Frisar frise)
    {
        this.frise = frise;
    }
    
    /**
     * Return the HeadComponent. To the rendering process, the renderer could
     * get properties from the frise. Typically, the current height.
     * 
     * @param frise
     * @return
     */
    public abstract Component getHeadComponent();
    
    /**
     * Return the period renderer.
     * 
     * @return
     */
    public abstract FriseComponentRenderer getPeriodRenderer();
    
    /**
     * Return the frise renderer.
     * 
     * @return
     */
    public abstract FriseComponentRenderer getEventRenderer();
    
    /**
     * Return the TailComponent.
     * @return
     */
    public abstract Component getTailComponent();
    
    /**
     * Return the name of the renderer. Used by Frisar.java
     * @return
     */
    public String getName()
    {
        return name;
    }
}

